////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (c) 2010 Leon Coto Rodriguez
//  leoncoto@gmail.com
//  
//  Permission is hereby granted, free of charge, to any person
//  obtaining a copy of this software and associated documentation
//  files (the "Software"), to deal in the Software without
//  restriction, including without limitation the rights to use,
//  copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the
//  Software is furnished to do so, subject to the following
//  conditions:
//  
//   The above copyright notice and this permission notice shall be
//   included in all copies or substantial portions of the Software.
//  
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
//  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
//  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
//  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
//  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
//  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
//  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
//  OTHER DEALINGS IN THE SOFTWARE.
//
////////////////////////////////////////////////////////////////////////////////
package org.flexspeedup.services.amf
{
import org.flexspeedup.services.IUserService;

import mx.rpc.AsyncToken;

/**
 * This class adds functionality to AbstractCollectionService, providing a way 
 * to authenticate users using a remote service.
 */
public class UserService extends AbstractCollectionService implements IUserService
{
    //--------------------------------------------------------------------------
    //
    //  Class constants
    //
    //--------------------------------------------------------------------------

    //--------------------------
    // AUTHENTICATE_USER_OPERATION
    //--------------------------
    /**
     * The default name for the remote operation corresnponding to the 
     * <code>authenticateUser</code> method in this class.
     */
    public static const AUTHENTICATE_USER_OPERATION:String = "authenticateUser";

    //--------------------------------------------------------------------------
    //
    // Constructor
    //
    //--------------------------------------------------------------------------

    /**
     * Creates an UserService instance 
     */
    public function UserService(destination:String=null)
    {
        super(destination);
    }

    //--------------------------------------------------------------------------
    //
    //  Properties
    //
    //--------------------------------------------------------------------------

    //----------------------------------
    // authenticateUserOperation
    //----------------------------------
    /**
     * The name for the remote operation corresponding to the 
     * <code>authenticateUser</code> method in this class, for a concrete 
     * implementation. 
     * 
     * @default "authenticateUser".
     */
    public var authenticateUserOperation:String = 
        UserService.AUTHENTICATE_USER_OPERATION;

    //--------------------------------------------------------------------------
    //
    //  Methods
    //
    //--------------------------------------------------------------------------

    /**
     * Concrete implementation.
     * @inheritDoc org.flexspeedup.services.IUserService#authenticateUser
     */
    public function authenticateUser(userName:String, hash:String, nonce:String):AsyncToken
    {
        return getOperation(authenticateUserOperation).send(
            userName, 
            hash, 
            nonce
        );
    }
}
}